Conversation
Contributor
Author
|
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/9909 |
|
Hi, @isolenov Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| ManagedIdentity.json | 2023-01-31(b9d3fed) | 2018-11-30(main) |
| ManagedIdentity.json | 2023-01-31(b9d3fed) | 2022-01-31-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-01-31 | package-2023-01-31(b9d3fed) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
TrackedResourcePatchOperation |
Tracked resource 'SystemAssignedIdentity' must have patch operation that at least supports the update of tags. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L37 |
TrackedResourcesMustHavePut |
The tracked resource SystemAssignedIdentity does not have a corresponding put operation. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L37 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ManagedIdentity/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L87 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L178 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L252 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L252 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L252 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L352 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L400 |
MissingTypeObject |
The schema 'Identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L539 |
MissingTypeObject |
The schema 'IdentityUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L571 |
MissingTypeObject |
The schema 'SystemAssignedIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L607 |
TopLevelResourcesListBySubscription |
The top-level resource 'SystemAssignedIdentity' does not have list by subscription operation, please add it. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L607 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L654 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L660 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L666 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L684 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L690 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L696 |
MissingTypeObject |
The schema 'UserAssignedIdentitiesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L749 |
MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L765 |
MissingTypeObject |
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L775 |
MissingTypeObject |
The schema 'OperationDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L820 |
MissingTypeObject |
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L846 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L879 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L902 |
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: MsiOperationsList Location: Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json#L74 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
Tag package-2023-01-31; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 12, untested: 0, failed: 1, passed: 11
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
CLIENT_ERROR |
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: SystemAssignedIdentities_GetByScope |
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Jan 30, 2023
tadelesh
reviewed
Jan 31, 2023
Comments are addressed
tadelesh
reviewed
Jan 31, 2023
tadelesh
reviewed
Jan 31, 2023
Comments are addressed
qiaozha
approved these changes
Feb 1, 2023
This was referenced Feb 1, 2023
This was referenced Feb 7, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.